[]
        
(Showing Draft Content)

Dashboard

Dashboard

[GET] /api/v2/dashboard/dashboards/{id}

获取仪表板

参数:

名称 类型 位置 描述
id必填项 string path 仪表板 ID
rev int32 query 仪表板修订

返回值

状态码: 200

成功

DashboardViewModel

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/dashboard/templates/{id}

获取模板

参数:

名称 类型 位置 描述
id必填项 string path 模板编号
rev int32 query 模板修改

返回值

状态码: 200

成功

DashboardViewModel

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/dashboard/{id}/revert

恢复仪表板

参数:

名称 类型 位置 描述
id必填项 string path 仪表板 ID
rev int32 query 仪表板修订

返回值

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/dashboard/dashboards/{id}/export

导出仪表板

参数:

名称 类型 位置 描述
id必填项 string path 仪表板 ID
dp string query 仪表板参数
token string query wyn 令牌

返回值

状态码: 200

成功

File

状态码: 400

错误的请求

ServerPluginError

状态码: 401

未经授权

ServerPluginError

状态码: 403

禁止

ServerPluginError

状态码: 404

未找到

ServerPluginError

类型定义

Ƭ DashboardViewModel

名称 类型 描述 示例
id可为空 string
title可为空 string
content Content
options可为空 any
scenarios可为空 Scenario
pages可为空 DashboardPage
sharedResources可为空 SharedResource
version可为空 string
datasetProfiles可为空 any
tagIds可为空 Array<string>
comment可为空 string
parameters可为空 DashboardParameter

Ƭ Content

名称 类型 描述 示例
docTheme可为空 any
filters可为空 Array
imageList可为空 DashboardImage
languageResource可为空 any

Ƭ Scenario

名称 类型 描述 示例
id可为空 string
content可为空 any
options可为空 any
pageId可为空 string
name可为空 string

Ƭ DashboardPage

名称 类型 描述 示例
id可为空 string
content可为空 any
options可为空 any

Ƭ SharedResource

名称 类型 描述 示例
id可为空 string
type DocumentType

Ƭ DashboardParameter

名称 类型 描述 示例
name可为空 string 参数名称。
prompt可为空 string 提示输入参数值时向用户显示的文本。
dataType可为空 string 参数的数据类型。
outputDataType可为空 string
dateOnly Boolean
multiValue Boolean
multiline Boolean
hidden Boolean
allowBlank Boolean
validValues ValidValues
defaultValue DefaultValue
binding Binding
transform Transform
valueType可为空 string

Ƭ DashboardImage

名称 类型 描述 示例
id可为空 string
name可为空 string
src可为空 string
size int32
type可为空 string
dashboardId可为空 string

Ƭ DocumentType

Enum:

  • Unknown
  • Dashboard
  • Dataset
  • DataSource
  • Image
  • Theme
  • MapHierarchy
  • GeoJson
  • Report
  • Visual
  • FloorPlan
  • AnalysisModel
  • Font
  • LanguageResource
  • NativeQuery
  • Scene
  • Glb
  • DashboardTemplate
  • VizTemplate
  • IoT

Ƭ ValidValues

名称 类型 描述 示例
datasetReference DatasetReference
values可为空 ParameterValue 获取参数的可能值的列表。

Ƭ DefaultValue

名称 类型 描述 示例
datasetReference DatasetReference
values可为空 Array<string> 获取参数的默认值。
logicValues可为空 LogicValue 获取默认值的逻辑值。

Ƭ Binding

名称 类型 描述 示例
value ParameterBindingValue
valueType可为空 string

Ƭ Transform

名称 类型 描述 示例
rule可为空 string
direction可为空 string
unit可为空 string
formatter可为空 string

Ƭ DatasetReference

表示要执行的查询以获得参数的默认值。

名称 类型 描述 示例
datasetId可为空 string
valueField可为空 string
entityName可为空 string
aggType可为空 string

Ƭ ParameterValue

名称 类型 描述 示例
label可为空 string 要在 UI 中显示的值的标签
value可为空 string 指定参数的值。

Ƭ LogicValue

名称 类型 描述 示例
valueType可为空 string
value可为空 string
datasetReference DatasetReference

Ƭ ParameterBindingValue

名称 类型 描述 示例
name可为空 string
valuePropertyName可为空 string
columns可为空 Array<string>
checkedFieldNames可为空 Array<string>

Ƭ ServerPluginError

服务器插件错误

名称 类型 描述 示例
code可为空 string 错误代码
message可为空 string 错误信息
context可为空 string 错误上下文

Ƭ File

名称 类型 描述 示例